becu-interop-platform-api

1.0.x
(0 reviews)

Proxy Promotion

Description

This page consists of the information regarding the operations performed to promote a proxy between environments.

This API can be leveraged to promote a proxy from a lower to a higher environment.

Endpoints

  • POST /assets/promote

API Design Endpoint Sequence Diagram

BECU Interop Platform API orchestrates API calls to the internal-Anypoint exchange APIs and Mulesoft Platform APIs to promote a proxy between enviroments.

resources/image-c4ccab01-2fcf-41c8-92a7-0684cf8b5438.png

Proxy Promotion

Proxy promotion is accessible under the POST /assets/promote endpoint, 3 headers are required:

  • environmentName with the value of the environment where the the asset to promote exists currently
  • promoteToEnvironmentName with the value of the environment where the asset will be promoted to
  • businessGroupId with the value of the business group where the asset resides

Proxy can only be promoted to a higher environment meaning dev can only promote to test and test to prod.

In the request body the user must pass the following values as an object:

  • assetId: The assetId of the proxy to promote
  • policies: Object to define the policies to keep in the promoted proxy
    • allEntities: Set to true to keep all policies in the promoted proxy, otherwise set to false
  • tiers: Object to define the tiers to keep in the promoted proxy
    • allEntities: Set to true to keep all tiers in the promoted proxy, otherwise set to false
  • alerts: Object to define the alerts to keep in the promoted proxy
    • allEntities: Set to true to keep all alerts in the promoted proxy, otherwise set to false

Below is an example of a request body object:

{ "instanceLabel": "test-business-group-test-demo-5-instance", "assetId": "business-group-test-demo-5", "policies": { "allEntities": true }, "tiers": { "allEntities": true }, "alerts": { "allEntities": true } }

Restrictions

  • Connectors & Common API Dependency

The BECU Interop Platform API, is consuming multiple connectors and Anypoint Platform REST APIs.

Below are the list of connectors which this API is consuming:

  • HTTP Connector
  • Transform Message
  • JSON Logger

Downstream Dependencies

Anypoint Platform REST APIs

Anypoint Platform Login API

Anypoint Exchange API for

  • Fetch Environment ID
  • Fetch API ID
  • Promote Proxy
  • Deploy Proxy

Reviews